/*
 * Copyright 2009 Original Author(s)
 * 
 * This file is part of Kommando
 * 
 * Kommando is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 * 
 * Kommando is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 * 
 * You should have received a copy of the GNU General Public License
 * along with Kommando.  If not, see <http://www.gnu.org/licenses/>.
 */
package org.kommando.core.controlcenter;

import javax.swing.JComponent;

import org.kommando.core.Identifiable;

/**
 * @author Peter De Bruycker
 */
public interface PreferencePage extends Identifiable {

    /**
     * Returns the component
     * 
     * @return
     */
    JComponent getComponent();

    /**
     * The parent id is used to determine to location in the {@link PreferenceDialog}.
     * <p>
     * If this method returns <code>null</code>, this {@link PreferencePage} is added as a root element, otherwise it is
     * added as a child of the {@link PreferencePage} with the returned id.
     * 
     * @return the parent id
     */
    String getParentId();

    boolean apply();

    void restoreDefaults();

    /**
     * The name is shown to the user.
     * 
     * @return the name, cannot be <code>null</code> or empty.
     */
    String getName();
}
